Python POC for GitHub-based API Reviews (Phase 2) by tjprescott · Pull Request #47443 · Azure/azure-sdk-for-python

tjprescott · 2026-06-10T20:54:10Z

Outlines the process for ensuring that changes to working branches are synced to any open review PRs.

Adds implementation of the proposed pipelines.

Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com>

Co-authored-by: tjprescott <5723682+tjprescott@users.noreply.github.com>

…e-sdk-for-python into GenerateAPITextScript

…le versions

pdates

…into APIReviewSync # Conflicts: # .github/workflows/api-consistency.yml # .github/workflows/api-md-workflow-tests.yml # eng/tools/azure-sdk-tools/azpysdk/apistub.py # eng/tools/azure-sdk-tools/tests/test_apistub.py # scripts/api_md_workflow/create_api_review_pr.py # scripts/api_md_workflow/create_api_review_pr_test.py

Copilot

Pull request overview

This PR implements “Phase 2” of the GitHub-based API review prototype by adding a dispatcher + sync mechanism that keeps open API review PR branches in sync with validated api.md / api.metadata.yml artifacts from a working branch once CI gates pass.

Changes:

Adds a dispatcher script and workflow to evaluate a “final CI gate”, discover matching open [API Review] PRs via embedded metadata, and dispatch per-review-branch sync runs.
Adds a sync script and workflow that compares/copies api.md + api.metadata.yml from a validated working SHA into the review branch and force-pushes with lease when changes exist.
Consolidates Node tooling dependencies under .github/package.json (removing the separate .github/chronus package definition/lock).

Reviewed changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
scripts/api_md_workflow/sync_review_branches_plan.md	Design/implementation plan describing gating, discovery, sync behavior, and safety checks.
.github/workflows/src/api-md-review-sync/sync_review_branch.test.js	Unit tests for artifact diff/copy behavior and stale-SHA skipping.
.github/workflows/src/api-md-review-sync/sync_review_branch.js	Sync implementation for comparing/copying API artifacts and pushing updates to review branches.
.github/workflows/src/api-md-review-sync/dispatch_review_branch_syncs.test.js	Unit tests for metadata parsing, PR matching, dispatching, and CI gate evaluation.
.github/workflows/src/api-md-review-sync/dispatch_review_branch_syncs.js	Dispatcher implementation: final CI gating, metadata parsing, PR discovery, and workflow dispatch.
.github/workflows/api-md-sync-review-branch.yml	Workflow to perform a single review-branch sync from working SHA artifacts.
.github/workflows/api-md-dispatch-review-syncs.yml	Workflow to resolve final CI gate and dispatch sync workflows for matching review PRs.
.github/shared/src/simple-git.js	Shared helper to resolve a git repo root via `simple-git`.
.github/shared/src/github.js	Shared GitHub-related enum constants/types (status/check terminology).
.github/shared/src/changed-files.js	Shared helper to compute changed files via git diff (now enables `simple-git` debug).
.github/package.json	Consolidated/pinned Node dependencies for GitHub automation and workflows.
.github/chronus/package.json	Removed (Chronus tooling dependency definition moved to `.github/package.json`).
.github/chronus/package-lock.json	Removed (Chronus lockfile no longer needed under `.github/chronus`).

Files not reviewed (1)

.github/chronus/package-lock.json: Generated file

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh run download "${{ steps.gate.outputs.consistency_run_id }}" --name api-md-affected-packages --dir .artifacts


+  const pullRequest = selectWorkingPullRequest(await getCommitPullRequestsFn(workingSha), workingSha);
+  if (!pullRequest) {
+    return { ready: false, reason: `No open pull request found for ${workingSha}.` };
+  }
+  if (pullRequest.head.ref.startsWith("apireview/")) {
+    return { ready: false, reason: `Skipping API review branch ${pullRequest.head.repo.owner.login}:${pullRequest.head.ref}.` };
+  }


+    const statusPassed = status && PASSING_STATUS_STATES.has(status.state);
+    const checkRunPassed =
+      checkRun && !isCurrentDispatcherRun(checkRun, currentRunId) && checkRun.status === "completed" && PASSING_CHECK_CONCLUSIONS.has(checkRun.conclusion);


+  return workingPaths.some((workingPath, index) => {
+    const reviewPath = reviewPaths[index];
+    return !readRequiredFile(workingPath).equals(Buffer.from(readFileOrUndefined(reviewPath) || ""));
+  });


tjprescott and others added 30 commits May 28, 2026 09:53

Add generate_api_text.py script.

fd2ab3d

Add PR creation script.

ebb3870

Review feedback.

2d24fa9

Add scripts for syncing api.md

e4b2876

Refactor create_api_review_pr from Python to JS in a module way.

dd1b565

Remove update process and just have a consistency check.

688e16f

Add minor change to azure-template to test pipeline.

323d4f3

Add API.md to test mismatch.

93184af

Apply actual api.md

7680ff6

Update GitHub Actions to latest major versions

33c39cf

Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com>

Add shared JS scripts from rest-api-specs repo.

15534d7

Refactor scripts to use shared code and simplify.

19f65ac

Code review feedback.

9d0946e

Add generated API.md for azure-template

ec760b0

Co-authored-by: tjprescott <5723682+tjprescott@users.noreply.github.com>

Refactor to use azpysdk apistub --md command.

d04b5db

Merge branch 'GenerateAPITextScript' of https://github.com/Azure/azur…

825c684

…e-sdk-for-python into GenerateAPITextScript

Remove Python 3.10 limit on apistub.py.

7f8eeb5

Refactor azpysdk apistub command. Extract metadata from API.md.

c75faac

Add validation for select metadata fields.

dfe985c

CI fixes.

9d8137c

Add skill for generating review PR.

760fc63

Update review generation logic.

1517d58

fix(python adapter): add shell:true on Windows for spawnSync

258a36a

fix(python adapter): pass --dest-dir so API.md lands in package dir

89e6c98

fix(python adapter): skip _generated dirs in readVersion to avoid sta…

62f81e3

…le versions

Make script idempotent and reuse branches with the same API hash.

92e0c92

Code review feedback.

bb253fa

Updates.

317bd4c

Make review PR creation only work for updates, not new packages.

a82a7ee

CI fixes.

8d07492

tjprescott added 6 commits June 10, 2026 09:21

Script fixes.

a7cabe5

Tweaks and remove APIs (more testing)

dd3e9d9

Code review feedback.

143033b

Consolidate package.json.

75f904e

Initial plan

9cde269

pdates

Initial implementations.

183b91a

tjprescott mentioned this pull request Jun 10, 2026

Proposal: API Review Sync Pipelines #47421

Closed

tjprescott requested a review from mikeharder June 10, 2026 20:55

tjprescott changed the base branch from main to GenerateAPITextScript June 10, 2026 20:55

tjprescott changed the title ~~Proposal: API Review Sync Pipelines~~ Python POC for GitHub-based API Reviews (Phase 2) Jun 12, 2026

Updates to preserve APIView behavior of "no API unless all checks pass"

e1c4f1f

tjprescott requested a review from praveenkuttappan June 12, 2026 17:52

Base automatically changed from GenerateAPITextScript to main June 12, 2026 23:34

tjprescott marked this pull request as ready for review June 15, 2026 16:19

tjprescott requested a review from danieljurek as a code owner June 15, 2026 16:19

Copilot AI review requested due to automatic review settings June 15, 2026 16:19

tjprescott requested a review from a team as a code owner June 15, 2026 16:19

Copilot started reviewing on behalf of tjprescott June 15, 2026 16:20 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

tjprescott added 3 commits June 15, 2026 09:41

Restore Chronus package files

25dd817

Remove unused shared scripts.

9a81464

Code review feedback.

52bc95f

tjprescott requested a review from Copilot June 15, 2026 17:33

Copilot started reviewing on behalf of tjprescott June 15, 2026 17:38 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

Comment thread .github/workflows/src/api-md-review-sync/dispatch_review_branch_syncs.js

Comment thread .github/workflows/src/api-md-review-sync/sync_review_branch.js Outdated

Code review feedback.

c4748a5

tjprescott requested a review from Copilot June 15, 2026 18:07

Copilot started reviewing on behalf of tjprescott June 15, 2026 18:08 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python POC for GitHub-based API Reviews (Phase 2)#47443

Python POC for GitHub-based API Reviews (Phase 2)#47443
tjprescott wants to merge 55 commits into
mainfrom
APIReviewSync

tjprescott commented Jun 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

tjprescott commented Jun 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants